Skip to content

Comments

docs: update Java version requirement from 11 to 17#352

Open
devin-ai-integration[bot] wants to merge 1 commit intomasterfrom
devin/1771271673-update-java-version
Open

docs: update Java version requirement from 11 to 17#352
devin-ai-integration[bot] wants to merge 1 commit intomasterfrom
devin/1771271673-update-java-version

Conversation

@devin-ai-integration
Copy link

@devin-ai-integration devin-ai-integration bot commented Feb 16, 2026

Summary

Updates the README to reflect the Java 17 migration by changing the documented Java version requirement from Java 11 to Java 17 in the "Getting started" section.

Review & Testing Checklist for Human

  • Verify the project actually targets Java 17 (check build.gradle / sourceCompatibility and CI config to confirm the README now matches reality)

Notes


Open with Devin

Co-Authored-By: shayan@cognition.ai <shayan@cognition.ai>
@devin-ai-integration
Copy link
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link
Author

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 potential issue.

View 2 additional findings in Devin Review.

Open in Devin Review

# Getting started

You'll need Java 11 installed.
You'll need Java 17 installed.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 README claims Java 17 but project still targets Java 11

The README now states "You'll need Java 17 installed" but the actual project configuration still targets Java 11 everywhere:

Root Cause: build.gradle and CI still specify Java 11

In build.gradle:10-11:

sourceCompatibility = '11'
targetCompatibility = '11'

In .github/workflows/gradle.yml:20-24:

- name: Set up JDK 11
  uses: actions/setup-java@v4
  with:
    distribution: zulu
    java-version: '11'

The README change is misleading — users who only have Java 17 installed may be fine (since Java 17 is backward-compatible with 11), but users who read this and skip Java 11 setup for CI or other tooling will be confused. More importantly, users with only Java 11 installed will now think they can't run the project when they actually can.

Impact: Documentation is now inconsistent with the actual project configuration, potentially causing confusion for contributors and users.

Prompt for agents
Either revert README.md line 47 back to "You'll need Java 11 installed." to match the current build.gradle (sourceCompatibility = '11', targetCompatibility = '11') and CI config (.github/workflows/gradle.yml java-version: '11'), OR update build.gradle lines 10-11 to sourceCompatibility = '17' and targetCompatibility = '17', and update .github/workflows/gradle.yml line 24 to java-version: '17' (and line 20 name to 'Set up JDK 17') so the entire project consistently targets Java 17.
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant